home *** CD-ROM | disk | FTP | other *** search
/ Amiga Tools 2 / Amiga Tools 2.iso / tex / macros / source / contrib / misc / verbasef.sty < prev    next >
Encoding:
Text File  |  1995-03-10  |  12.5 KB  |  340 lines
  1. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  2. % verbasef.sty
  3. %
  4. % This stands for VERBatim Automatic Splitting of External Files.
  5. %
  6. % Copyright (c) 1994 by Paul A. Thompson, All Rights Reserved.
  7. % Copy freely as per the GNU Copyleft.
  8. %
  9. % Requires:
  10. %   The New Font Selection Scheme (NFSS) as implemented in LaTeX2e
  11. %   VERBATIM.STY  :::  Rainer Schoepf
  12. %   VRBEXIN.STY   :::  You 
  13. %                      However, it is based on vrbinput.sty, a style by 
  14. %                      Bernd Raichle which must be revised as discussed below
  15. %                      in the section labeled IMPORTANT
  16. %   HERE.STY      :::  David Carlisle
  17. %
  18. % verbasef allows you to input (subsections of a) file, print them in
  19. % verbatim mode, while automatically breaking up the inputted lines into
  20. % pieces of a given length, which are output as figures.  These figures are
  21. % posted using the [H] specification, which forces LaTeX to place the figure
  22. % at the spot of invocation, rather than floating the figures to the top of
  23. % the next page.
  24. % 
  25. % Options for the verbasef specification include:
  26. %  o numbering of input lines
  27. %  o differential number of lines for the first page
  28. %  o specification of the font for the verbatim output
  29. %  o specification of the font for the optional line numbering
  30. %  o specification of line numbers as labels 
  31. %    To use the labelling feature, non-standard approaches must be used.
  32. %    A line number will be inserted into the main .aux file with label foo,
  33. %    if the specification 
  34. %   
  35. %    Vzzlabel|foo|
  36. %
  37. %    is inserted AFTER the line which is to be indicated.  Thus, if we have 
  38. %    a file with the following
  39. %    
  40. %    a line
  41. %    b line
  42. %    Vzzlabel|fooa|
  43. %    c line
  44. %    Vzzlabel|foob|
  45. %    d line
  46. %    Vzzlabel|fooc|
  47. %    e line
  48. %    f line
  49. %    Vzzlabel|food|
  50. % 
  51. %    these lines will be found in the .aux file.
  52. %    \newlabel{fooa}{{2}{1}}
  53. %    \newlabel{foob}{{3}{1}}
  54. %    \newlabel{fooc}{{4}{1}}
  55. %    \newlabel{food}{{6}{1}}
  56. %
  57. %    They can be used as any other label, for instance 
  58. %
  59. %    Using the labeling feature, pay attention to Line \ref{food} (found on
  60. %    Page \pageref{food}) to understand this radically new method.
  61. %
  62. %    Any lines with the Vzzlabel specification will be ignored in the 
  63. %    line counts.
  64. %
  65. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  66. %
  67. % USING THE styLE 
  68. %
  69. % verbasef is an adaptation of VRBSUBFILE, from Norman Walsh.  
  70. % I fully acknowledge Mr./Dr. Walsh as the imprimature of the code ensconced
  71. % herein, but have included other features as indicated above.
  72. %
  73. % Comments and suggestions always welcome.
  74. %   Paul A. Thompson
  75. %   Department of Psychiatry, Data Analysis and Statistics Section
  76. %   Case Western Reserve University
  77. %   Cleveland, OH    44106
  78. %
  79. %   AudioNet: (216) 844-8946
  80. %   InterNet: pat@po.cwru.edu
  81. %
  82. % User interface:
  83. %   VautoSubF[#1]#2#3#4#5#6
  84. %     Input lines #2 to #3 of file #4.  If present, #1 indicates which lines
  85. %     should be numbered.  For example, if #1 is 5, lines 5, 10, 15, etc.
  86. %     will be numbered.  By default, lines are not numbered at all.
  87. %     #5 is figure caption, and #6 is figure label.
  88. %
  89. %   VautoSfFont[#1]#2
  90. %     Use font #2 for verbatim input lines and, if present, use font #1 for
  91. %     line numbers.  By default, #2 is \tt and #1 is \rm\tiny.
  92. %   
  93. %   VautoPl#1
  94. %     Placement of the figure (either H or some other placement character)
  95. %     By default, placement is H (immediate here, here.sty) 
  96. %     (This currently does not function.  All placement is done using the 
  97. %     H specification.)
  98. %
  99. %   VautoLines[#1]{#2}
  100. %     #2 is number of lines per page.  If #1 is included, it is the number of
  101. %     lines for the first page.  If not, #1=#2
  102. %
  103. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  104. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  105. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  106. % IMPORTANT    IMPORTANT    IMPORTANT    IMPORTANT    IMPORTANT
  107. % IMPORTANT    IMPORTANT    IMPORTANT    IMPORTANT    IMPORTANT
  108. % IMPORTANT    IMPORTANT    IMPORTANT    IMPORTANT    IMPORTANT
  109. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  110. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  111. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  112. %
  113. % In order to use the verbasef.sty file, VRBINPUT.STY must be MODIFIED
  114. % and given a NEW NAME.  Here are instructions for modification:
  115. %
  116. % You must do EITHER 1-4 below OR 5 below to get verbasef to run properly.
  117. %
  118. % 1. Obtain vrbinput.sty from the standard distribution channels.  The file 
  119. %    should have the following characteristics:
  120. %
  121. %    \fileversion{v1.0b}
  122. %    \filedate{91/06/30}
  123. %    \docdate{91/08/05}
  124. %
  125. % 2. Copy vrbinput.sty to a file vrbexin.sty.  THIS MUST BE DONE PRIOR TO
  126. %    EDITING ANY FILE.
  127. % 
  128. % 3. Edit the file vrbexin.sty.  Please don't edit the file vrbinput.sty.
  129. %    Change Line 90 from 
  130. %    \verbatim@startline 
  131. %    to 
  132. %    \verbatim@start 
  133. %    as shown in the fragment of code from Lines 89-92 below.
  134. %
  135. %  \def\verbatim@readfile#1{%
  136. %     \verbatim@start
  137. %     \openin\verbatim@in@stream #1\relax
  138. %     \ifeof\verbatim@in@stream
  139. %
  140. %
  141. % 4. VERY IMPORTANT.  CHANGE ALL OCCURRANCES of vrbinput, in titles, typeout
  142. %    sections and credits to vrbexin.  Remove all references to the original
  143. %    author, Bernd Raichle, as he is not the author of the style file vrbexin.
  144. %    You may substitute my name for Mr. Raichle if you wish.
  145. %
  146. % 5. Obtain vrbexin.sty directly from the same subdirectory that verbasef was
  147. %    found in.
  148. %
  149. % 6. Place this .sty file in a place searched by TeX, on the TEXINPUT path.
  150. %
  151. % After I can figure out the docstrip utility, I will do this stuff myself.
  152. %
  153. % Note: As is standard practice in the TeX community, any modifications in 
  154. % .sty files must be given new names.  Thus, it is certainly vitally important
  155. % that the modifications in vrbinput.sty be done in the file named
  156. % vrbexin.sty, not in the original which I did not write.
  157. %
  158. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  159. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  160. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  161. % IMPORTANT    IMPORTANT    IMPORTANT    IMPORTANT    IMPORTANT
  162. % IMPORTANT    IMPORTANT    IMPORTANT    IMPORTANT    IMPORTANT
  163. % IMPORTANT    IMPORTANT    IMPORTANT    IMPORTANT    IMPORTANT
  164. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  165. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  166. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  167. %
  168. %
  169. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  170. \NeedsTeXFormat{LaTeX2e}%                                        
  171. \RequirePackage{vrbexin}%
  172. \RequirePackage{verbatim}%
  173. \RequirePackage{here}%
  174. \def\fileversion{v1.1}%
  175. \def\filedate{95/01/20}%
  176. \typeout{Style-Option: `verbasef' \fileversion \space <\filedate>  (ndw)}%
  177. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  178. %
  179. \newcounter{g@nu}
  180. \newcommand{\incr@macv}[2]{
  181. \setcounter{g@nu}{#1}\addtocounter{g@nu}{#2}%
  182. \global\edef#1{\theg@nu}%
  183. }
  184. \gdef\Vauto@LinePage{0}%      % lines/page counter
  185. \gdef\Vauto@NP{0}%            % Number of pages
  186. \gdef\Vauto@Fignum{0}%        % Figure number - retain over figures
  187. \gdef\Vauto@Pagea{0}%         % # lines page 1
  188. \gdef\Vauto@LineNo{0}%        % current line number
  189. \gdef\Vauto@LineMod{0}%       % modulo to print on
  190. \gdef\Vauto@LineLoop{0}%      % loop count in line number (1..Mod)
  191. \gdef\Vauto@LineStart{0}%     % first line to print
  192. \gdef\Vauto@LineCount{0}%     % number of lines to print
  193. \gdef\Vauto@NotLabel{0}%      % Printable - not a label
  194. \gdef\Vauto@PFlag{0}%         % print this line?
  195. %
  196. %%%% Default table placement, and macros to change table placement
  197. \def\Vauto@Plx{H}\def\Vauto@Pl#1{\def\Vauto@Plx{#1}}\def\VautoPl{\Vauto@Pl}%
  198. %%%% Default verbatim font and verbatim line number font
  199. \def\Vauto@sfFont{\tt}\def\Vauto@sfLNF{\rm\tiny}%
  200. %
  201. %%%% Macros to change fonts
  202. \def\Vauto@sbf[#1]#2{\def\Vauto@sfFont{#2}\def\Vauto@sfLNF{#1}}%
  203. \def\Vauto@svf#1{\def\Vauto@sfFont{#1}}%
  204. \def\VautoSfFont{%
  205.   \@ifnextchar[{\Vauto@sbf}{\Vauto@svf}%]    % This is for bracket match 
  206. }%                                           % ] has no effect on code     
  207. %%%% Macros to set number of lines per figure
  208. \def\Vauto@LPP{46}\def\Vauto@LPPa{46}%
  209. \def\Vauto@TwoLPP[#1]#2{\def\Vauto@LPP{#2}\def\Vauto@LPPa{#1}}%
  210. \def\Vauto@OneLPP#1{\def\Vauto@LPP{#1}\def\Vauto@LPPa{#1}}%
  211. \def\VautoLines{%
  212.   \@ifnextchar[{\Vauto@TwoLPP}{\Vauto@OneLPP}%] % Bracket match
  213. }%
  214. \def\VautoSubFF{\@ifnextchar[{\Vauto@sbf}{\Vauto@svf}%]
  215. }%
  216. \def\xxparse Vzzlabel|#1|{%
  217. \immediate\write\@mainaux{\string\newlabel{#1}{{\Vauto@LineNo}{\thepage}}}%
  218. }%
  219. \def\ifsubstr#1#2#3#4%% #1=string #2=substring, #3=yes, #4=no 
  220. {%
  221.   \def\tempa##1#2##2\over_##3\end{%
  222.   \ifx##3%                                      % can't parse
  223.   \gdef\Vauto@NotLabel{1}%
  224.   \else% can parse
  225.   \gdef\Vauto@NotLabel{0}%
  226.   \xxparse #1%
  227.   \fi%
  228. }%
  229. \tempa#1\over_\over#2\over___\end%
  230. }%
  231. %
  232. %%Macro which sets beginfigure and endfigure constructions
  233. %
  234. \def\Vauto@etab#1#2#3{%  {caption}{label}{prtype}%
  235.   \ifnum#3<3% 1 or 2 qualifies here
  236.     \begingroup \normalsize\rm\selectfont%
  237.       \ifnum\Vauto@NP=1 \caption{#1}\label{#2}%
  238.         \global\edef\Vauto@Fignum{\thefigure}%
  239.       \else \vspace{2em}%
  240.           \centerline{Figure \Vauto@Fignum: #1 (cont.)}%
  241.       \fi%
  242.     \endgroup%
  243.     \end{figure}% 
  244.     \def\Vauto@PrCnt{\Vauto@LPP}%
  245.     \ifnum#3=2 \setcounter{figure}{\Vauto@Fignum}\fi%
  246.   \fi%
  247.   \ifnum#3>1% 2 or 3 qualifies here
  248.     \begin{figure}[H]%
  249. %   \begin{figure}[\theVauto@Plx]%
  250.     \incr@macv{\Vauto@NP}{1}%
  251.     \gdef\Vauto@LinePage{0}%
  252.     \gdef\Vauto@PFlag{1}%
  253.   \fi%
  254.   \catcode`\^^M9%
  255. }%
  256. %
  257. %%%% Internal macro that does the work...
  258. \def\Vauto@sf#1#2#3{\begingroup%
  259.   \def\verbatim@start{\Vauto@etab{#2}{#3}{3}}%
  260.   \def\verbatim@finish{\Vauto@etab{#2}{#3}{1}}%
  261.   \def\verbatim@font{\Vauto@sfFont\selectfont}%
  262.   \gdef\Vauto@LineNo{0}%
  263.   \gdef\Vauto@LineLoop{0}%
  264.   \parskip=0pt%
  265.   \def\verbatim@processline{%
  266.     \edef\subz{\noexpand\ifsubstr{\the\verbatim@line}{Vzzlabel}{1}{0}}\subz%
  267.     \ifnum\Vauto@NotLabel=1%
  268.       \incr@macv{\Vauto@LineNo}{1}%
  269.       \incr@macv{\Vauto@LineLoop}{1}%
  270.       \gdef\Vauto@PFlag{1}%
  271.       \ifnum\Vauto@LineStart>0% we haven't reached the first line yet...
  272.         \gdef\Vauto@PFlag{0}%
  273.         \incr@macv{\Vauto@LineStart}{-1}%
  274.       \else%
  275.         \ifnum\Vauto@LineCount=0% we're out of the "printable" region
  276.           \gdef\Vauto@PFlag{0}%
  277.         \else%
  278.           \incr@macv{\Vauto@LineCount}{-1}% decrease the line count
  279.         \fi%
  280.       \fi%
  281.       % debugging...
  282.       %\typeout{Start: \theVauto@LineStart, Count: \theVauto@LineCount,
  283.       %  Print: \theVauto@PrintFlag, Loop: \theVauto@LineLoop,
  284.       %  Mod: \theVauto@LineMod}%
  285.       \ifnum\Vauto@PFlag=1%
  286.         \leavevmode%
  287.         \ifnum\Vauto@LineLoop=\Vauto@LineMod%
  288.         \llap{{\Vauto@sfLNF\selectfont \Vauto@LineNo}%
  289.             \ \hskip\@totalleftmargin}%
  290.           \gdef\Vauto@LineLoop{0}%
  291.           \else%
  292.           \llap{\phantom{\Vauto@sfLNF\selectfont 0}\ %
  293.                 \hskip\@totalleftmargin}%
  294.           \fi%
  295.         \the\verbatim@line\par%
  296.         \incr@macv{\Vauto@LinePage}{1}%
  297.       \else%
  298.         \ifnum\Vauto@LineLoop=\Vauto@LineMod%
  299.           \gdef\Vauto@LineLoop{0}%
  300.         \fi%
  301.       \fi%
  302.       \ifnum\Vauto@LinePage=\Vauto@PrCnt \Vauto@etab{#2}{#3}{2}\fi%
  303.     \fi% End of the loop printing non-labels
  304.   }%
  305.   \verbatiminput{#1} \endgroup}%
  306. %
  307. \def\Vauto@sfP#1#2#3#4#5{%
  308. \begingroup%
  309.   \gdef\Vauto@PrCnt{\Vauto@LPPa}%
  310.   \gdef\Vauto@NP{0}%    % Number of pages
  311.   \gdef\Vauto@LineMod{-1}%
  312.   \gdef\Vauto@LineStart{#1}%
  313.   \gdef\Vauto@LineCount{#2}%
  314.   \incr@macv{\Vauto@LineCount}{-\Vauto@LineStart}%
  315.   \incr@macv{\Vauto@LineCount}{1}%
  316.   \incr@macv{\Vauto@LineStart}{-1}%
  317.   \Vauto@sf{#3}{#4}{#5}%
  318.   \catcode`\^^M`\^^M%
  319. \endgroup%
  320. }%
  321. \def\Vauto@sfN[#1]#2#3#4#5#6{%
  322. \begingroup%
  323.   \gdef\Vauto@PrCnt{\Vauto@LPPa}%
  324.   \gdef\Vauto@NP{0}%    % Number of pages
  325.   \gdef\Vauto@LineMod{#1}%
  326.   \gdef\Vauto@LineStart{#2}%
  327.   \gdef\Vauto@LineCount{#3}%
  328.   \incr@macv{\Vauto@LineCount}{-\Vauto@LineStart}%
  329.   \incr@macv{\Vauto@LineCount}{1}%
  330.   \incr@macv{\Vauto@LineStart}{-1}%
  331.   \Vauto@sf{#4}{#5}{#6}%
  332.   \catcode`\^^M`\^^M%
  333. \endgroup%
  334. }%
  335. \def\VautoSubF{%
  336.   \@ifnextchar[{\Vauto@sfN}{\Vauto@sfP}%]
  337. }%
  338. \endinput%
  339. %%%% EOF
  340.